vcProductMatcher

vcProductMatcher monitors product needs and feeds and matches them with each other. A vcProductNeedFeedMatch instance is created for each matched pair. A match can be made if the process group ID of the need and feed matches, the product type is accepted by the need (defined in product filter), and a valid transport solution exists between the transport nodes.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcProcessController.ProductMatcher

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
PendingFeedsvcList[vcProductFeed]RGets a list of all pending feeds.
PendingNeedsvcList[vcProductNeed]RGets a list of all pending needs.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
addFeedNonevcProductFeed feedAdds the product feed to the product matcher to be matched with a need.
See more
Parameters:
feed (vcProductFeed): The product feed to be added to the matcher.

Exceptions:
ValueError: When product feed has already been added to the product matcher.
ValueError: When product feed has been matched, it cannot be re-used before the match is disposed.
addNeedNonevcProductNeed needAdds the product need to the product matcher to be matched with a feed.
See more
Parameters:
need (vcProductNeed): The product need to be added to the matcher.

Exceptions:
ValueError: When product need has already been added to the product matcher.
ValueError: When product need has been matched, it cannot be re-used before the match is disposed.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnPendingFeedAddedvcProductFeed feedTriggered when a new feed has been added to the product matcher.

Parameters:
feed (vcProductFeed): The added feed.
OnPendingNeedAddedvcProductNeed needTriggered when a new need has been added to the product matcher.

Parameters:
need (vcProductNeed): The added need.